<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="classroom_v1.html">Google Classroom API</a> . <a href="classroom_v1.courses.html">courses</a> . <a href="classroom_v1.courses.courseWorkMaterials.html">courseWorkMaterials</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="classroom_v1.courses.courseWorkMaterials.addOnAttachments.html">addOnAttachments()</a></code>
</p>
<p class="firstline">Returns the addOnAttachments Resource.</p>

<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(courseId, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work material in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed or if more than 20 * materials are provided. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible</p>
<p class="toc_element">
  <code><a href="#delete">delete(courseId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a course work material. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work material item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.</p>
<p class="toc_element">
  <code><a href="#get">get(courseId, id, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work material, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work material does not exist.</p>
<p class="toc_element">
  <code><a href="#getAddOnContext">getAddOnContext(courseId, itemId, addOnToken=None, attachmentId=None, postId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user's role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.</p>
<p class="toc_element">
  <code><a href="#list">list(courseId, courseWorkMaterialStates=None, materialDriveId=None, materialLink=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(courseId, id, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates one or more fields of a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if the requested course or course work material does not exist</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(courseId, body=None, x__xgafv=None)</code>
  <pre>Creates a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work material in the requested course, share a Drive attachment, or for access errors. * `INVALID_ARGUMENT` if the request is malformed or if more than 20 * materials are provided. * `NOT_FOUND` if the requested course does not exist. * `FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  body: object, The request body.
    The object takes the form of:

{ # Course work material created by a teacher for students of the course
  &quot;alternateLink&quot;: &quot;A String&quot;, # Absolute link to this course work material in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
  &quot;assigneeMode&quot;: &quot;A String&quot;, # Assignee mode of the course work material. If unspecified, the default value is `ALL_STUDENTS`.
  &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
  &quot;creationTime&quot;: &quot;A String&quot;, # Timestamp when this course work material was created. Read-only.
  &quot;creatorUserId&quot;: &quot;A String&quot;, # Identifier for the user that created the course work material. Read-only.
  &quot;description&quot;: &quot;A String&quot;, # Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters.
  &quot;id&quot;: &quot;A String&quot;, # Classroom-assigned identifier of this course work material, unique per course. Read-only.
  &quot;individualStudentsOptions&quot;: { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the course work material. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the course work material.
    &quot;studentIds&quot;: [ # Identifiers for the students that have access to the coursework/announcement.
      &quot;A String&quot;,
    ],
  },
  &quot;materials&quot;: [ # Additional materials. A course work material must have no more than 20 material items.
    { # Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.
      &quot;driveFile&quot;: { # Drive file that is used as material for course work. # Google Drive file material.
        &quot;driveFile&quot;: { # Representation of a Google Drive file. # Drive file details.
          &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to access the Drive item. Read-only.
          &quot;id&quot;: &quot;A String&quot;, # Drive API resource ID.
          &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the Drive item. Read-only.
          &quot;title&quot;: &quot;A String&quot;, # Title of the Drive item. Read-only.
        },
        &quot;shareMode&quot;: &quot;A String&quot;, # Mechanism by which students access the Drive item.
      },
      &quot;form&quot;: { # Google Forms item. # Google Forms material. Read-only.
        &quot;formUrl&quot;: &quot;A String&quot;, # URL of the form.
        &quot;responseUrl&quot;: &quot;A String&quot;, # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the Form. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Form. Read-only.
      },
      &quot;gem&quot;: { # Gemini Gem link. # Gemini Gem material. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # Gems resource id.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Gem. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL that can be used to access the Gem. Read-only.
      },
      &quot;link&quot;: { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the target URL. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the target of the URL. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
      },
      &quot;notebook&quot;: { # NotebookLM Notebook link. # NotebookLM Notebook material. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # Notebook resource id.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Notebook. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL that can be used to access the Notebook. Read-only.
      },
      &quot;youtubeVideo&quot;: { # YouTube video item. # YouTube video material.
        &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to view the YouTube video. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # YouTube API resource ID.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the YouTube video. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the YouTube video. Read-only.
      },
    },
  ],
  &quot;scheduledTime&quot;: &quot;A String&quot;, # Optional timestamp when this course work material is scheduled to be published.
  &quot;state&quot;: &quot;A String&quot;, # Status of this course work material. If unspecified, the default state is `DRAFT`.
  &quot;title&quot;: &quot;A String&quot;, # Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
  &quot;topicId&quot;: &quot;A String&quot;, # Identifier for the topic that this course work material is associated with. Must match an existing topic in the course.
  &quot;updateTime&quot;: &quot;A String&quot;, # Timestamp of the most recent change to this course work material. Read-only.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Course work material created by a teacher for students of the course
  &quot;alternateLink&quot;: &quot;A String&quot;, # Absolute link to this course work material in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
  &quot;assigneeMode&quot;: &quot;A String&quot;, # Assignee mode of the course work material. If unspecified, the default value is `ALL_STUDENTS`.
  &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
  &quot;creationTime&quot;: &quot;A String&quot;, # Timestamp when this course work material was created. Read-only.
  &quot;creatorUserId&quot;: &quot;A String&quot;, # Identifier for the user that created the course work material. Read-only.
  &quot;description&quot;: &quot;A String&quot;, # Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters.
  &quot;id&quot;: &quot;A String&quot;, # Classroom-assigned identifier of this course work material, unique per course. Read-only.
  &quot;individualStudentsOptions&quot;: { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the course work material. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the course work material.
    &quot;studentIds&quot;: [ # Identifiers for the students that have access to the coursework/announcement.
      &quot;A String&quot;,
    ],
  },
  &quot;materials&quot;: [ # Additional materials. A course work material must have no more than 20 material items.
    { # Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.
      &quot;driveFile&quot;: { # Drive file that is used as material for course work. # Google Drive file material.
        &quot;driveFile&quot;: { # Representation of a Google Drive file. # Drive file details.
          &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to access the Drive item. Read-only.
          &quot;id&quot;: &quot;A String&quot;, # Drive API resource ID.
          &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the Drive item. Read-only.
          &quot;title&quot;: &quot;A String&quot;, # Title of the Drive item. Read-only.
        },
        &quot;shareMode&quot;: &quot;A String&quot;, # Mechanism by which students access the Drive item.
      },
      &quot;form&quot;: { # Google Forms item. # Google Forms material. Read-only.
        &quot;formUrl&quot;: &quot;A String&quot;, # URL of the form.
        &quot;responseUrl&quot;: &quot;A String&quot;, # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the Form. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Form. Read-only.
      },
      &quot;gem&quot;: { # Gemini Gem link. # Gemini Gem material. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # Gems resource id.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Gem. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL that can be used to access the Gem. Read-only.
      },
      &quot;link&quot;: { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the target URL. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the target of the URL. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
      },
      &quot;notebook&quot;: { # NotebookLM Notebook link. # NotebookLM Notebook material. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # Notebook resource id.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Notebook. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL that can be used to access the Notebook. Read-only.
      },
      &quot;youtubeVideo&quot;: { # YouTube video item. # YouTube video material.
        &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to view the YouTube video. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # YouTube API resource ID.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the YouTube video. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the YouTube video. Read-only.
      },
    },
  ],
  &quot;scheduledTime&quot;: &quot;A String&quot;, # Optional timestamp when this course work material is scheduled to be published.
  &quot;state&quot;: &quot;A String&quot;, # Status of this course work material. If unspecified, the default state is `DRAFT`.
  &quot;title&quot;: &quot;A String&quot;, # Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
  &quot;topicId&quot;: &quot;A String&quot;, # Identifier for the topic that this course work material is associated with. Must match an existing topic in the course.
  &quot;updateTime&quot;: &quot;A String&quot;, # Timestamp of the most recent change to this course work material. Read-only.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(courseId, id, x__xgafv=None)</code>
  <pre>Deletes a course work material. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work material item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if no course exists with the requested ID.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  id: string, Identifier of the course work material to delete. This identifier is a Classroom-assigned identifier. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(courseId, id, x__xgafv=None)</code>
  <pre>Returns a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work material, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course or course work material does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  id: string, Identifier of the course work material. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Course work material created by a teacher for students of the course
  &quot;alternateLink&quot;: &quot;A String&quot;, # Absolute link to this course work material in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
  &quot;assigneeMode&quot;: &quot;A String&quot;, # Assignee mode of the course work material. If unspecified, the default value is `ALL_STUDENTS`.
  &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
  &quot;creationTime&quot;: &quot;A String&quot;, # Timestamp when this course work material was created. Read-only.
  &quot;creatorUserId&quot;: &quot;A String&quot;, # Identifier for the user that created the course work material. Read-only.
  &quot;description&quot;: &quot;A String&quot;, # Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters.
  &quot;id&quot;: &quot;A String&quot;, # Classroom-assigned identifier of this course work material, unique per course. Read-only.
  &quot;individualStudentsOptions&quot;: { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the course work material. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the course work material.
    &quot;studentIds&quot;: [ # Identifiers for the students that have access to the coursework/announcement.
      &quot;A String&quot;,
    ],
  },
  &quot;materials&quot;: [ # Additional materials. A course work material must have no more than 20 material items.
    { # Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.
      &quot;driveFile&quot;: { # Drive file that is used as material for course work. # Google Drive file material.
        &quot;driveFile&quot;: { # Representation of a Google Drive file. # Drive file details.
          &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to access the Drive item. Read-only.
          &quot;id&quot;: &quot;A String&quot;, # Drive API resource ID.
          &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the Drive item. Read-only.
          &quot;title&quot;: &quot;A String&quot;, # Title of the Drive item. Read-only.
        },
        &quot;shareMode&quot;: &quot;A String&quot;, # Mechanism by which students access the Drive item.
      },
      &quot;form&quot;: { # Google Forms item. # Google Forms material. Read-only.
        &quot;formUrl&quot;: &quot;A String&quot;, # URL of the form.
        &quot;responseUrl&quot;: &quot;A String&quot;, # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the Form. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Form. Read-only.
      },
      &quot;gem&quot;: { # Gemini Gem link. # Gemini Gem material. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # Gems resource id.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Gem. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL that can be used to access the Gem. Read-only.
      },
      &quot;link&quot;: { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the target URL. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the target of the URL. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
      },
      &quot;notebook&quot;: { # NotebookLM Notebook link. # NotebookLM Notebook material. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # Notebook resource id.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Notebook. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL that can be used to access the Notebook. Read-only.
      },
      &quot;youtubeVideo&quot;: { # YouTube video item. # YouTube video material.
        &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to view the YouTube video. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # YouTube API resource ID.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the YouTube video. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the YouTube video. Read-only.
      },
    },
  ],
  &quot;scheduledTime&quot;: &quot;A String&quot;, # Optional timestamp when this course work material is scheduled to be published.
  &quot;state&quot;: &quot;A String&quot;, # Status of this course work material. If unspecified, the default state is `DRAFT`.
  &quot;title&quot;: &quot;A String&quot;, # Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
  &quot;topicId&quot;: &quot;A String&quot;, # Identifier for the topic that this course work material is associated with. Must match an existing topic in the course.
  &quot;updateTime&quot;: &quot;A String&quot;, # Timestamp of the most recent change to this course work material. Read-only.
}</pre>
</div>

<div class="method">
    <code class="details" id="getAddOnContext">getAddOnContext(courseId, itemId, addOnToken=None, attachmentId=None, postId=None, x__xgafv=None)</code>
  <pre>Gets metadata for Classroom add-ons in the context of a specific post. To maintain the integrity of its own data and permissions model, an add-on should call this to validate query parameters and the requesting user&#x27;s role whenever the add-on is opened in an [iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/iframes-overview). This method returns the following error codes: * `PERMISSION_DENIED` for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if one of the identified resources does not exist.

Args:
  courseId: string, Required. Identifier of the course. (required)
  itemId: string, Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. (required)
  addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on&#x27;s URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post.
  attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/workspace/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).
  postId: string, Optional. Deprecated, use `item_id` instead.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Attachment-relevant metadata for Classroom add-ons in the context of a specific post.
  &quot;courseId&quot;: &quot;A String&quot;, # Immutable. Identifier of the course.
  &quot;itemId&quot;: &quot;A String&quot;, # Immutable. Identifier of the `Announcement`, `CourseWork`, or `CourseWorkMaterial` under which the attachment is attached.
  &quot;postId&quot;: &quot;A String&quot;, # Immutable. Deprecated, use `item_id` instead.
  &quot;studentContext&quot;: { # Role-specific context if the requesting user is a student. # Add-on context corresponding to the requesting user&#x27;s role as a student. Its presence implies that the requesting user is a student in the course.
    &quot;submissionId&quot;: &quot;A String&quot;, # Requesting user&#x27;s submission id to be used for grade passback and to identify the student when showing student work to the teacher. This is set exactly when `supportsStudentWork` is `true`.
  },
  &quot;supportsStudentWork&quot;: True or False, # Optional. Whether the post allows the teacher to see student work and passback grades.
  &quot;teacherContext&quot;: { # Role-specific context if the requesting user is a teacher. # Add-on context corresponding to the requesting user&#x27;s role as a teacher. Its presence implies that the requesting user is a teacher in the course.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(courseId, courseWorkMaterialStates=None, materialDriveId=None, materialLink=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course does not exist.

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  courseWorkMaterialStates: string, Restriction on the work status to return. Only course work material that matches is returned. If unspecified, items with a work status of `PUBLISHED` is returned. (repeated)
    Allowed values
      COURSEWORK_MATERIAL_STATE_UNSPECIFIED - No state specified. This is never returned.
      PUBLISHED - Status for course work material that has been published. This is the default state.
      DRAFT - Status for a course work material that is not yet published. Course work material in this state is visible only to course teachers and domain administrators.
      DELETED - Status for course work material that was published but is now deleted. Course work material in this state is visible only to course teachers and domain administrators. Course work material in this state is deleted after some time.
  materialDriveId: string, Optional filtering for course work material with at least one Drive material whose ID matches the provided string. If `material_link` is also specified, course work material must have materials matching both filters.
  materialLink: string, Optional filtering for course work material with at least one link material whose URL partially matches the provided string.
  orderBy: string, Optional sort ordering for results. A comma-separated list of fields with an optional sort direction keyword. Supported field is `updateTime`. Supported direction keywords are `asc` and `desc`. If not specified, `updateTime desc` is the default behavior. Examples: `updateTime asc`, `updateTime`
  pageSize: integer, Maximum number of items to return. Zero or unspecified indicates that the server may assign a maximum. The server may return fewer than the specified number of results.
  pageToken: string, nextPageToken value returned from a previous list call, indicating that the subsequent page of results should be returned. The list request must be otherwise identical to the one that resulted in this token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response when listing course work material.
  &quot;courseWorkMaterial&quot;: [ # Course work material items that match the request.
    { # Course work material created by a teacher for students of the course
      &quot;alternateLink&quot;: &quot;A String&quot;, # Absolute link to this course work material in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
      &quot;assigneeMode&quot;: &quot;A String&quot;, # Assignee mode of the course work material. If unspecified, the default value is `ALL_STUDENTS`.
      &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
      &quot;creationTime&quot;: &quot;A String&quot;, # Timestamp when this course work material was created. Read-only.
      &quot;creatorUserId&quot;: &quot;A String&quot;, # Identifier for the user that created the course work material. Read-only.
      &quot;description&quot;: &quot;A String&quot;, # Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters.
      &quot;id&quot;: &quot;A String&quot;, # Classroom-assigned identifier of this course work material, unique per course. Read-only.
      &quot;individualStudentsOptions&quot;: { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the course work material. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the course work material.
        &quot;studentIds&quot;: [ # Identifiers for the students that have access to the coursework/announcement.
          &quot;A String&quot;,
        ],
      },
      &quot;materials&quot;: [ # Additional materials. A course work material must have no more than 20 material items.
        { # Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.
          &quot;driveFile&quot;: { # Drive file that is used as material for course work. # Google Drive file material.
            &quot;driveFile&quot;: { # Representation of a Google Drive file. # Drive file details.
              &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to access the Drive item. Read-only.
              &quot;id&quot;: &quot;A String&quot;, # Drive API resource ID.
              &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the Drive item. Read-only.
              &quot;title&quot;: &quot;A String&quot;, # Title of the Drive item. Read-only.
            },
            &quot;shareMode&quot;: &quot;A String&quot;, # Mechanism by which students access the Drive item.
          },
          &quot;form&quot;: { # Google Forms item. # Google Forms material. Read-only.
            &quot;formUrl&quot;: &quot;A String&quot;, # URL of the form.
            &quot;responseUrl&quot;: &quot;A String&quot;, # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
            &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the Form. Read-only.
            &quot;title&quot;: &quot;A String&quot;, # Title of the Form. Read-only.
          },
          &quot;gem&quot;: { # Gemini Gem link. # Gemini Gem material. Read-only.
            &quot;id&quot;: &quot;A String&quot;, # Gems resource id.
            &quot;title&quot;: &quot;A String&quot;, # Title of the Gem. Read-only.
            &quot;url&quot;: &quot;A String&quot;, # URL that can be used to access the Gem. Read-only.
          },
          &quot;link&quot;: { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
            &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the target URL. Read-only.
            &quot;title&quot;: &quot;A String&quot;, # Title of the target of the URL. Read-only.
            &quot;url&quot;: &quot;A String&quot;, # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
          },
          &quot;notebook&quot;: { # NotebookLM Notebook link. # NotebookLM Notebook material. Read-only.
            &quot;id&quot;: &quot;A String&quot;, # Notebook resource id.
            &quot;title&quot;: &quot;A String&quot;, # Title of the Notebook. Read-only.
            &quot;url&quot;: &quot;A String&quot;, # URL that can be used to access the Notebook. Read-only.
          },
          &quot;youtubeVideo&quot;: { # YouTube video item. # YouTube video material.
            &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to view the YouTube video. Read-only.
            &quot;id&quot;: &quot;A String&quot;, # YouTube API resource ID.
            &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the YouTube video. Read-only.
            &quot;title&quot;: &quot;A String&quot;, # Title of the YouTube video. Read-only.
          },
        },
      ],
      &quot;scheduledTime&quot;: &quot;A String&quot;, # Optional timestamp when this course work material is scheduled to be published.
      &quot;state&quot;: &quot;A String&quot;, # Status of this course work material. If unspecified, the default state is `DRAFT`.
      &quot;title&quot;: &quot;A String&quot;, # Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
      &quot;topicId&quot;: &quot;A String&quot;, # Identifier for the topic that this course work material is associated with. Must match an existing topic in the course.
      &quot;updateTime&quot;: &quot;A String&quot;, # Timestamp of the most recent change to this course work material. Read-only.
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # Token identifying the next page of results to return. If empty, no further results are available.
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(courseId, id, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates one or more fields of a course work material. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work material has already been deleted. * `NOT_FOUND` if the requested course or course work material does not exist

Args:
  courseId: string, Identifier of the course. This identifier can be either the Classroom-assigned identifier or an alias. (required)
  id: string, Identifier of the course work material. (required)
  body: object, The request body.
    The object takes the form of:

{ # Course work material created by a teacher for students of the course
  &quot;alternateLink&quot;: &quot;A String&quot;, # Absolute link to this course work material in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
  &quot;assigneeMode&quot;: &quot;A String&quot;, # Assignee mode of the course work material. If unspecified, the default value is `ALL_STUDENTS`.
  &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
  &quot;creationTime&quot;: &quot;A String&quot;, # Timestamp when this course work material was created. Read-only.
  &quot;creatorUserId&quot;: &quot;A String&quot;, # Identifier for the user that created the course work material. Read-only.
  &quot;description&quot;: &quot;A String&quot;, # Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters.
  &quot;id&quot;: &quot;A String&quot;, # Classroom-assigned identifier of this course work material, unique per course. Read-only.
  &quot;individualStudentsOptions&quot;: { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the course work material. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the course work material.
    &quot;studentIds&quot;: [ # Identifiers for the students that have access to the coursework/announcement.
      &quot;A String&quot;,
    ],
  },
  &quot;materials&quot;: [ # Additional materials. A course work material must have no more than 20 material items.
    { # Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.
      &quot;driveFile&quot;: { # Drive file that is used as material for course work. # Google Drive file material.
        &quot;driveFile&quot;: { # Representation of a Google Drive file. # Drive file details.
          &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to access the Drive item. Read-only.
          &quot;id&quot;: &quot;A String&quot;, # Drive API resource ID.
          &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the Drive item. Read-only.
          &quot;title&quot;: &quot;A String&quot;, # Title of the Drive item. Read-only.
        },
        &quot;shareMode&quot;: &quot;A String&quot;, # Mechanism by which students access the Drive item.
      },
      &quot;form&quot;: { # Google Forms item. # Google Forms material. Read-only.
        &quot;formUrl&quot;: &quot;A String&quot;, # URL of the form.
        &quot;responseUrl&quot;: &quot;A String&quot;, # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the Form. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Form. Read-only.
      },
      &quot;gem&quot;: { # Gemini Gem link. # Gemini Gem material. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # Gems resource id.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Gem. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL that can be used to access the Gem. Read-only.
      },
      &quot;link&quot;: { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the target URL. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the target of the URL. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
      },
      &quot;notebook&quot;: { # NotebookLM Notebook link. # NotebookLM Notebook material. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # Notebook resource id.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Notebook. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL that can be used to access the Notebook. Read-only.
      },
      &quot;youtubeVideo&quot;: { # YouTube video item. # YouTube video material.
        &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to view the YouTube video. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # YouTube API resource ID.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the YouTube video. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the YouTube video. Read-only.
      },
    },
  ],
  &quot;scheduledTime&quot;: &quot;A String&quot;, # Optional timestamp when this course work material is scheduled to be published.
  &quot;state&quot;: &quot;A String&quot;, # Status of this course work material. If unspecified, the default state is `DRAFT`.
  &quot;title&quot;: &quot;A String&quot;, # Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
  &quot;topicId&quot;: &quot;A String&quot;, # Identifier for the topic that this course work material is associated with. Must match an existing topic in the course.
  &quot;updateTime&quot;: &quot;A String&quot;, # Timestamp of the most recent change to this course work material. Read-only.
}

  updateMask: string, Mask that identifies which fields on the course work material to update. This field is required to do an update. The update fails if invalid fields are specified. If a field supports empty values, it can be cleared by specifying it in the update mask and not in the course work material object. If a field that does not support empty values is included in the update mask and not set in the course work material object, an `INVALID_ARGUMENT` error is returned. The following fields may be specified by teachers: * `title` * `description` * `state` * `scheduled_time` * `topic_id`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Course work material created by a teacher for students of the course
  &quot;alternateLink&quot;: &quot;A String&quot;, # Absolute link to this course work material in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.
  &quot;assigneeMode&quot;: &quot;A String&quot;, # Assignee mode of the course work material. If unspecified, the default value is `ALL_STUDENTS`.
  &quot;courseId&quot;: &quot;A String&quot;, # Identifier of the course. Read-only.
  &quot;creationTime&quot;: &quot;A String&quot;, # Timestamp when this course work material was created. Read-only.
  &quot;creatorUserId&quot;: &quot;A String&quot;, # Identifier for the user that created the course work material. Read-only.
  &quot;description&quot;: &quot;A String&quot;, # Optional description of this course work material. The text must be a valid UTF-8 string containing no more than 30,000 characters.
  &quot;id&quot;: &quot;A String&quot;, # Classroom-assigned identifier of this course work material, unique per course. Read-only.
  &quot;individualStudentsOptions&quot;: { # Assignee details about a coursework/announcement. This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Identifiers of students with access to the course work material. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field can see the course work material.
    &quot;studentIds&quot;: [ # Identifiers for the students that have access to the coursework/announcement.
      &quot;A String&quot;,
    ],
  },
  &quot;materials&quot;: [ # Additional materials. A course work material must have no more than 20 material items.
    { # Material attached to course work. When creating attachments, setting the `form`, `gem`, or `notebook` field is not supported.
      &quot;driveFile&quot;: { # Drive file that is used as material for course work. # Google Drive file material.
        &quot;driveFile&quot;: { # Representation of a Google Drive file. # Drive file details.
          &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to access the Drive item. Read-only.
          &quot;id&quot;: &quot;A String&quot;, # Drive API resource ID.
          &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the Drive item. Read-only.
          &quot;title&quot;: &quot;A String&quot;, # Title of the Drive item. Read-only.
        },
        &quot;shareMode&quot;: &quot;A String&quot;, # Mechanism by which students access the Drive item.
      },
      &quot;form&quot;: { # Google Forms item. # Google Forms material. Read-only.
        &quot;formUrl&quot;: &quot;A String&quot;, # URL of the form.
        &quot;responseUrl&quot;: &quot;A String&quot;, # URL of the form responses document. Only set if responses have been recorded and only when the requesting user is an editor of the form. Read-only.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the Form. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Form. Read-only.
      },
      &quot;gem&quot;: { # Gemini Gem link. # Gemini Gem material. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # Gems resource id.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Gem. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL that can be used to access the Gem. Read-only.
      },
      &quot;link&quot;: { # URL item. # Link material. On creation, this is upgraded to a more appropriate type if possible, and this is reflected in the response.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the target URL. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the target of the URL. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL to link to. This must be a valid UTF-8 string containing between 1 and 2024 characters.
      },
      &quot;notebook&quot;: { # NotebookLM Notebook link. # NotebookLM Notebook material. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # Notebook resource id.
        &quot;title&quot;: &quot;A String&quot;, # Title of the Notebook. Read-only.
        &quot;url&quot;: &quot;A String&quot;, # URL that can be used to access the Notebook. Read-only.
      },
      &quot;youtubeVideo&quot;: { # YouTube video item. # YouTube video material.
        &quot;alternateLink&quot;: &quot;A String&quot;, # URL that can be used to view the YouTube video. Read-only.
        &quot;id&quot;: &quot;A String&quot;, # YouTube API resource ID.
        &quot;thumbnailUrl&quot;: &quot;A String&quot;, # URL of a thumbnail image of the YouTube video. Read-only.
        &quot;title&quot;: &quot;A String&quot;, # Title of the YouTube video. Read-only.
      },
    },
  ],
  &quot;scheduledTime&quot;: &quot;A String&quot;, # Optional timestamp when this course work material is scheduled to be published.
  &quot;state&quot;: &quot;A String&quot;, # Status of this course work material. If unspecified, the default state is `DRAFT`.
  &quot;title&quot;: &quot;A String&quot;, # Title of this course work material. The title must be a valid UTF-8 string containing between 1 and 3000 characters.
  &quot;topicId&quot;: &quot;A String&quot;, # Identifier for the topic that this course work material is associated with. Must match an existing topic in the course.
  &quot;updateTime&quot;: &quot;A String&quot;, # Timestamp of the most recent change to this course work material. Read-only.
}</pre>
</div>

</body></html>